GET
/
v1
/
promotion-codes
curl --request GET \
  --url https://api.hyperline.co/v1/promotion-codes \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "promo_DKL4Xcb5VSa8CQ",
      "code": "PROMO123",
      "coupon_id": "cou_DKL4Xcb5VSa8CQ",
      "client_id": "cli_DKL4Xcb5VSa8CQ",
      "customer_id": "cus_DKL4Xcb5VSa8CQ",
      "plan_id": "plan_DKL4Xcb5VSa8CQ",
      "product_id": "itm_DKL4Xcb5VSa8CQ",
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-01-01T00:00:00.000Z",
      "expires_at": "2021-01-01T00:00:00.000Z",
      "max_redemptions": 10,
      "current_redemptions": 0,
      "duration_count": 1,
      "duration_period": "months",
      "only_for_first_time_order": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
take
number | null
default:50
Required range: 0 <= x <= 100
​
skip
number | null
default:0
Required range: x >= 0
​
coupon_id
string
​
coupon_id__not
string
​
coupon_id__isNull
string
​
coupon_id__isNotNull
string
​
coupon_id__equals
string
​
coupon_id__contains
string
​
coupon_id__startsWith
string
​
coupon_id__endWith
string

Response

200 - application/json

The response is of type object.